Scenario #1101: Add Phone Number to Contact Data

Properties

Required

Given

name value
partnerName Matthieu
phoneNumberKeyToAdd mobile
phoneNumberToAdd +49 152 1234567

partnerContactUuid

HTTP GET "/api/hs/office/relations?relationType=PARTNER&personData=Matthieu" \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }`
=> status: 200 OK 
[ {
  "uuid" : "ed2fbf99-b83d-4513-88dc-18d8229017cf",
  "anchor" : {
    "uuid" : "bb7b76f1-1922-46aa-8c22-468c70c3a9fa", // Person: Hostsharing eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Hostsharing eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "42f2f790-db43-4347-93b9-9b2ef60f3c36", // Person: Michelle Matthieu
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Michelle",
    "familyName" : "Matthieu"
  },
  "type" : "PARTNER",
  "mark" : null,
  "contact" : {
    "uuid" : "adb4df0b-d210-4a0b-bc87-4035b754b6ae", // Contact: Michelle Matthieu
    "caption" : "Michelle Matthieu",
    "postalAddress" : {
      "zipcode" : "22123",
      "country" : "Germany",
      "city" : "Hamburg",
      "street" : "An der Wandse 34",
      "name" : "Michelle Matthieu"
    },
    "emailAddresses" : {
      "main" : "michelle@matthieu.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 40 123456"
    }
  }
} ]

In production, data this query could result in multiple outputs. In that case, you have to find out which is the right one.

Patch the Additional Phone-Number into the Contact

HTTP PATCH "/api/hs/office/contacts/adb4df0b-d210-4a0b-bc87-4035b754b6ae" // Contact: Michelle Matthieu \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }` \
  -H 'Content-Type: application/json' \
  --data-binary @- <<EOF
{
  "phoneNumbers" : {
    "mobile" : "+49 152 1234567"
  }
}
EOF
=> status: 200 OK

Verify if the New Phone Number Got Added

HTTP GET "/api/hs/office/relations?relationType=PARTNER&personData=Matthieu" \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }`
=> status: 200 OK 
[ {
  "uuid" : "ed2fbf99-b83d-4513-88dc-18d8229017cf",
  "anchor" : {
    "uuid" : "bb7b76f1-1922-46aa-8c22-468c70c3a9fa", // Person: Hostsharing eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Hostsharing eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "42f2f790-db43-4347-93b9-9b2ef60f3c36", // Person: Michelle Matthieu
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Michelle",
    "familyName" : "Matthieu"
  },
  "type" : "PARTNER",
  "mark" : null,
  "contact" : {
    "uuid" : "adb4df0b-d210-4a0b-bc87-4035b754b6ae", // Contact: Michelle Matthieu
    "caption" : "Michelle Matthieu",
    "postalAddress" : {
      "zipcode" : "22123",
      "country" : "Germany",
      "city" : "Hamburg",
      "street" : "An der Wandse 34",
      "name" : "Michelle Matthieu"
    },
    "emailAddresses" : {
      "main" : "michelle@matthieu.example.org"
    },
    "phoneNumbers" : {
      "mobile" : "+49 152 1234567",
      "office" : "+49 40 123456"
    }
  }
} ]

generated on 2026-07-17 01:42:25 for branch